chore(release): render docs in the changelog and widen the commitlint scopes - #124
Merged
Conversation
MarTrepodi
force-pushed
the
chore/changelog-docs-section
branch
from
August 3, 2026 02:19
0186e55 to
a0fb51f
Compare
MarTrepodi
force-pushed
the
chore/changelog-docs-section
branch
from
August 3, 2026 02:31
a0fb51f to
6cc83d9
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changelog generation currently drops every
docscommit, and duplicates entries for single-commit PRs.Changes
Render the
docssection —[tool.git-changelog]set nosectionskey, so only the angular convention's defaults (feat,fix,revert,refactor,perf) reached the changelog. Supplyingsectionsreplaces the default list rather than extending it, so the defaults are spelled out alongsidedocs.Keep the release bookkeeping commit out of the rendered sections —
prepare-release.ymlcommitted the regenerated changelog asdocs(changelog): update for ${tag}. Withdocsnow rendered, every release would list the previous release's own changelog regeneration. Changed tochore(changelog), which is not in the render list.Cover the scopes actually in use in the commitlint enum — surveyed the scopes appearing in real commits against the allowed list. Nine were missing and all map to real code areas:
client,auth,statcalc,exceptions,cache,defaults,typing,parity, andchangelog. The rule is warn-only, so nothing was failing, but the warnings were noise.Deliberately omitted:
contributinganddependabot, used once each and already covered bydocsanddeps.Note
This does not fix the duplicate-entry problem itself. That was caused by the repository's
merge_commit_titlesetting beingPR_TITLE, which gave every merge commit a subject identical to the underlying commit on single-commit PRs. That setting has been changed toMERGE_MESSAGEand needs no code change. Existing history is unaffected, so the v2.3.0 changelog will still show the #117 cache feature twice unless that line is removed by hand on the release PR.🤖 Generated with Claude Code